<html>
<head>
<title>Docs For Class readDir</title>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>

<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
  <tr>
    <td class="header_top">smt2</td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
  <tr>
    <td class="header_menu">
        
                                    
                                                                      		  [ <a href="../classtrees_smt2.html" class="menu">class tree: smt2</a> ]
		  [ <a href="../elementindex_smt2.html" class="menu">index: smt2</a> ]
		  	    [ <a href="../elementindex.html" class="menu">all elements</a> ]
    </td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
</table>

<table width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="200" class="menu">
      <b>Packages:</b><br />
              <a href="../li_smt2.html">smt2</a><br />
              <a href="../li_PegasusPHP.html">PegasusPHP</a><br />
              <a href="../li_PHPMailer.html">PHPMailer</a><br />
            <br /><br />
                        <b>Files:</b><br />
      	  <div class="package">
			<a href="../smt2/_class.cluster.php.html">		class.cluster.php
		</a><br>
			<a href="../smt2/_class.domutil.php.html">		class.domutil.php
		</a><br>
			<a href="../smt2/_class.kmeans.php.html">		class.kmeans.php
		</a><br>
			<a href="../smt2/_class.point.php.html">		class.point.php
		</a><br>
			<a href="../smt2/_class.prettydate.php.html">		class.prettydate.php
		</a><br>
			<a href="../smt2/_class.readdir.php.html">		class.readdir.php
		</a><br>
			<a href="../smt2/_define.php.html">		define.php
		</a><br>
			<a href="../smt2/_functions.db.php.html">		functions.db.php
		</a><br>
			<a href="../smt2/_functions.php.html">		functions.php
		</a><br>
			<a href="../smt2/_messages.php.html">		messages.php
		</a><br>
	  </div><br />
      
      
            <b>Classes:</b><br />
        <div class="package">
		    		<a href="../smt2/Cluster.html">Cluster</a><br />
	    		<a href="../smt2/DOMUtil.html">DOMUtil</a><br />
	    		<a href="../smt2/KMeans.html">KMeans</a><br />
	    		<a href="../smt2/Point.html">Point</a><br />
	    		<a href="../smt2/prettyDate.html">prettyDate</a><br />
	    		<a href="../smt2/readDir.html">readDir</a><br />
	  </div>
                </td>
    <td>
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">

<h1>Class: readDir</h1>
Source Location: /class.readdir.php<br /><br />


<table width="100%" border="0">
<tr><td valign="top">

<h3><a href="#class_details">Class Overview</a></h3>
<pre></pre><br />
<div class="description">Reads a Directory and executes defined events when each directory element is read</div><br /><br />
<h4>Author(s):</h4>
<ul>
        </ul>




    

        
</td>

<td valign="top">
<h3><a href="#class_vars">Variables</a></h3>
<ul>
    <li><a href="../smt2/readDir.html#var$errcount">$errcount</a></li>
    <li><a href="../smt2/readDir.html#var$errtxt">$errtxt</a></li>
    <li><a href="../smt2/readDir.html#var$events">$events</a></li>
    <li><a href="../smt2/readDir.html#var$handlers">$handlers</a></li>
    <li><a href="../smt2/readDir.html#var$path">$path</a></li>
    <li><a href="../smt2/readDir.html#var$recurse">$recurse</a></li>
  </ul>
</td>


<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
    <li><a href="../smt2/readDir.html#methodreadDir">readDir</a></li>
    <li><a href="../smt2/readDir.html#methoderror">error</a></li>
    <li><a href="../smt2/readDir.html#methoderrorCount">errorCount</a></li>
    <li><a href="../smt2/readDir.html#methodread">read</a></li>
    <li><a href="../smt2/readDir.html#methodreadRecursive">readRecursive</a></li>
    <li><a href="../smt2/readDir.html#methodsetEvent">setEvent</a></li>
    <li><a href="../smt2/readDir.html#methodsetPath">setPath</a></li>
    <li><a href="../smt2/readDir.html#method_error">_error</a></li>
    <li><a href="../smt2/readDir.html#method_read">_read</a></li>
    <li><a href="../smt2/readDir.html#method_trigger">_trigger</a></li>
  </ul>
</td>

</tr></table>
<hr />

<table width="100%" border="0"><tr>






</tr></table>
<hr />

<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
[line <a href="../__filesource/fsource_smt2__class.readdir.php.html#a27">27</a>]<br />
Reads a Directory and executes defined events when each directory element is read<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>link:</b>&nbsp;&nbsp;</td><td><a href="http://www.fijiwebdesign.com/fiji-web-design-blog/linear-php-read-directory-class.html">http://www.fijiwebdesign.com/fiji-web-design-blog/linear-php-read-directory-class.html</a></td>
  </tr>
</table>
</div>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />

<hr />
<a name="class_vars"></a>
<h3>Class Variables</h3>
<div class="tags">
	<a name="var$errcount"></a>
	<p></p>
	<h4>$errcount = <span class="value"></span></h4>
	<p>[line <a href="../__filesource/fsource_smt2__class.readdir.php.html#a31">31</a>]</p>
  
  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>mixed</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
	<a name="var$errtxt"></a>
	<p></p>
	<h4>$errtxt = <span class="value"></span></h4>
	<p>[line <a href="../__filesource/fsource_smt2__class.readdir.php.html#a30">30</a>]</p>
  
  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>mixed</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
	<a name="var$events"></a>
	<p></p>
	<h4>$events = <span class="value"></span></h4>
	<p>[line <a href="../__filesource/fsource_smt2__class.readdir.php.html#a33">33</a>]</p>
  
  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>mixed</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
	<a name="var$handlers"></a>
	<p></p>
	<h4>$handlers = <span class="value"></span></h4>
	<p>[line <a href="../__filesource/fsource_smt2__class.readdir.php.html#a34">34</a>]</p>
  
  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>mixed</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
	<a name="var$path"></a>
	<p></p>
	<h4>$path = <span class="value"></span></h4>
	<p>[line <a href="../__filesource/fsource_smt2__class.readdir.php.html#a29">29</a>]</p>
  
  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>mixed</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
	<a name="var$recurse"></a>
	<p></p>
	<h4>$recurse = <span class="value"></span></h4>
	<p>[line <a href="../__filesource/fsource_smt2__class.readdir.php.html#a32">32</a>]</p>
  
  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>mixed</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
</div><br />

<hr />
<a name="class_methods"></a>
<h3>Class Methods</h3>
<div class="tags">

  <hr />
	<a name="methodreadDir"></a>
	<h3>constructor readDir <span class="smalllinenumber">[line <a href="../__filesource/fsource_smt2__class.readdir.php.html#a37">37</a>]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>readDir readDir(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Constructor<br /><br /><br /><br />

	
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methoderror"></a>
	<h3>method error <span class="smalllinenumber">[line <a href="../__filesource/fsource_smt2__class.readdir.php.html#a138">138</a>]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void error(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		View the last error logged<br /><br /><br /><br />

	
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methoderrorCount"></a>
	<h3>method errorCount <span class="smalllinenumber">[line <a href="../__filesource/fsource_smt2__class.readdir.php.html#a143">143</a>]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void errorCount(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		View the last error number<br /><br /><br /><br />

	
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodread"></a>
	<h3>method read <span class="smalllinenumber">[line <a href="../__filesource/fsource_smt2__class.readdir.php.html#a81">81</a>]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void read(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Read the directory<br /><br /><br /><br />

	
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodreadRecursive"></a>
	<h3>method readRecursive <span class="smalllinenumber">[line <a href="../__filesource/fsource_smt2__class.readdir.php.html#a76">76</a>]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void readRecursive(
[bool
$bool = true])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Set if we want to read through sub folders recursively<br /><br /><br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">bool&nbsp;&nbsp;</td>
        <td><b>$bool</b>&nbsp;&nbsp;</td>
        <td>TRUE or FALSE</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetEvent"></a>
	<h3>method setEvent <span class="smalllinenumber">[line <a href="../__filesource/fsource_smt2__class.readdir.php.html#a62">62</a>]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setEvent(
string
$event, string
$handler)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Set and event handler<br /><br /><br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$event</b>&nbsp;&nbsp;</td>
        <td>event name</td>
      </tr>
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$handler</b>&nbsp;&nbsp;</td>
        <td>event handler function name</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetPath"></a>
	<h3>method setPath <span class="smalllinenumber">[line <a href="../__filesource/fsource_smt2__class.readdir.php.html#a48">48</a>]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setPath(
string
$path)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Set the directory to read<br /><br /><br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$path</b>&nbsp;&nbsp;</td>
        <td>full directory path</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="method_error"></a>
	<h3>method _error <span class="smalllinenumber">[line <a href="../__filesource/fsource_smt2__class.readdir.php.html#a132">132</a>]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void _error(

$txt)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">&nbsp;&nbsp;</td>
        <td><b>$txt</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="method_read"></a>
	<h3>method _read <span class="smalllinenumber">[line <a href="../__filesource/fsource_smt2__class.readdir.php.html#a91">91</a>]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void _read(

$dir)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">&nbsp;&nbsp;</td>
        <td><b>$dir</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="method_trigger"></a>
	<h3>method _trigger <span class="smalllinenumber">[line <a href="../__filesource/fsource_smt2__class.readdir.php.html#a122">122</a>]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void _trigger(

$event, 
$path, 
$el)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">&nbsp;&nbsp;</td>
        <td><b>$event</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
          <tr>
        <td class="type">&nbsp;&nbsp;</td>
        <td><b>$path</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
          <tr>
        <td class="type">&nbsp;&nbsp;</td>
        <td><b>$el</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
</div><br />


        <div class="credit">
		    <hr />
		    Documentation generated on Sun, 21 Feb 2010 16:07:24 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.1</a>
	      </div>
      </td></tr></table>
    </td>
  </tr>
</table>

</body>
</html>